exp init: add basic template support #6630
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The template is not usable yet in packages nor it will be initialized during 'dvc init' though. But it supports custom templates if user adds the template in .dvc/stages or in dvc's codebase on resources/stages.
skshetry
commented
Sep 16, 2021
skshetry
commented
Sep 16, 2021
skshetry
commented
Sep 16, 2021
skshetry
commented
Sep 16, 2021
|
LGTM so far,
Did you already think about how to include that support? I have a similar problem in #6550 and my research led me to |
|
This is stale, superseded by #6681. |
@pared, I have not researched about this yet, as I don't want to add the support till we are done with all the changes with |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds basic support for templating on
dvc exp init.interactiveandexplicitare not supported yet. The custom templates are supported,but right now, as we don't initialize it in
dvc init, it has to be added manually in.dvc/stagesby theuser. I don't want to add that support yet before having this stable, as we may have some backward incompatible changes, so for testing, you'd have to do
mkdir .dvc/stagesyourself for a while.The default templates are not usable yet for binary packages users.
Note that the stage is appended after the template has been parsed, validated and then processed by stage when dumping, so it may not reflect the template very well, there may be formatting differences.
I tried using direct updates first, but doing that, it leaves formatting issues generated by templates (like whitespaces, empty newlines, etc.) and comment gets left-shifted. So, I went with the
stage.dump()option. We could roll back to it if we want to in the future.In terms of code, all of the stuff related to initialization has been moved to
experiments.initmodule, but I am still hesitant to add it torepo.experimentsas a new API.Also, it adds a dependency on
jinja2. Regarding tests, I have only added simple ones and I don't plan to add until this feature starts taking shape.